🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more

@commitlint/lint

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@commitlint/lint

Lint a string against commitlint rules

17.8.1
Version published
Weekly downloads
4.7M
-16.48%
Maintainers
4
Weekly downloads
 
Created

What is @commitlint/lint?

The @commitlint/lint package is a part of the commitlint toolset that is used to lint commit messages according to a specified set of rules. It helps maintain a consistent commit history and enforces a commit message convention, which is beneficial for automated processing of commit logs, generating changelogs, and aiding in code reviews.

What are @commitlint/lint's main functionalities?

Linting Commit Messages

This feature allows you to lint commit messages using a set of predefined rules. The code sample demonstrates how to use the lint function to check if a commit message follows the specified rules for the commit type and subject case.

const { lint } = require('@commitlint/lint');
const message = 'feat: add new feature';
const rules = {
  'type-enum': [2, 'always', ['feat', 'fix', 'docs', 'style', 'refactor', 'test', 'chore']],
  'subject-case': [2, 'never', ['start-case', 'pascal-case', 'upper-case']]
};

lint(message, rules).then(report => {
  console.log(report);
});

Other packages similar to @commitlint/lint

FAQs

Package last updated on 20 Oct 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts